<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>MongoAuthOptions | @vertx/auth-mongo</title>
	<meta name="description" content="">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">@vertx/auth-mongo</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../globals.html">Globals</a>
				</li>
				<li>
					<a href="mongoauthoptions.html">MongoAuthOptions</a>
				</li>
			</ul>
			<h1>Class MongoAuthOptions</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-comment">
				<div class="tsd-comment tsd-typography">
					<div class="lead">
						<p>Options configuring Mongo authentication.</p>
					</div>
					<dl class="tsd-comment-tags">
						<dt>author</dt>
						<dd><p><a href="mailto:julien@julienviet.com">Julien Viet</a></p>
						</dd>
					</dl>
				</div>
			</section>
			<section class="tsd-panel tsd-hierarchy">
				<h3>Hierarchy</h3>
				<ul class="tsd-hierarchy">
					<li>
						<span class="target">MongoAuthOptions</span>
					</li>
				</ul>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Constructors</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="mongoauthoptions.html#constructor" class="tsd-kind-icon">constructor</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Methods</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#getcollectionname" class="tsd-kind-icon">get<wbr>Collection<wbr>Name</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#getconfig" class="tsd-kind-icon">get<wbr>Config</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#getdatasourcename" class="tsd-kind-icon">get<wbr>Datasource<wbr>Name</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#getpasswordfield" class="tsd-kind-icon">get<wbr>Password<wbr>Field</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#getpermissionfield" class="tsd-kind-icon">get<wbr>Permission<wbr>Field</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#getrolefield" class="tsd-kind-icon">get<wbr>Role<wbr>Field</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#getsaltfield" class="tsd-kind-icon">get<wbr>Salt<wbr>Field</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#getsaltstyle" class="tsd-kind-icon">get<wbr>Salt<wbr>Style</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#getshared" class="tsd-kind-icon">get<wbr>Shared</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#getusernamecredentialfield" class="tsd-kind-icon">get<wbr>Username<wbr>Credential<wbr>Field</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#getusernamefield" class="tsd-kind-icon">get<wbr>Username<wbr>Field</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#setcollectionname" class="tsd-kind-icon">set<wbr>Collection<wbr>Name</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#setconfig" class="tsd-kind-icon">set<wbr>Config</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#setdatasourcename" class="tsd-kind-icon">set<wbr>Datasource<wbr>Name</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#setpasswordfield" class="tsd-kind-icon">set<wbr>Password<wbr>Field</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#setpermissionfield" class="tsd-kind-icon">set<wbr>Permission<wbr>Field</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#setrolefield" class="tsd-kind-icon">set<wbr>Role<wbr>Field</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#setsaltfield" class="tsd-kind-icon">set<wbr>Salt<wbr>Field</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#setsaltstyle" class="tsd-kind-icon">set<wbr>Salt<wbr>Style</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#setshared" class="tsd-kind-icon">set<wbr>Shared</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#setusernamecredentialfield" class="tsd-kind-icon">set<wbr>Username<wbr>Credential<wbr>Field</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mongoauthoptions.html#setusernamefield" class="tsd-kind-icon">set<wbr>Username<wbr>Field</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Constructors</h2>
				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
					<a name="constructor" class="tsd-anchor"></a>
					<h3>constructor</h3>
					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">new <wbr>Mongo<wbr>Auth<wbr>Options<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></li>
						<li class="tsd-signature tsd-kind-icon">new <wbr>Mongo<wbr>Auth<wbr>Options<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:24</li>
								</ul>
							</aside>
							<h4 class="tsd-returns-title">Returns <a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></h4>
						</li>
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:26</li>
								</ul>
							</aside>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>obj: <a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></h4>
						</li>
					</ul>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Methods</h2>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getcollectionname" class="tsd-anchor"></a>
					<h3>get<wbr>Collection<wbr>Name</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Collection<wbr>Name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:34</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The property name to be used to set the name of the collection inside the config.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getconfig" class="tsd-anchor"></a>
					<h3>get<wbr>Config</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Config<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:50</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The mongo client configuration: see Mongo Client documentation.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
							<p>a reference to this, so the API can be used fluently</p>
							<ul class="tsd-parameters">
								<li class="tsd-parameter-index-signature">
									<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5>
								</li>
							</ul>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getdatasourcename" class="tsd-anchor"></a>
					<h3>get<wbr>Datasource<wbr>Name</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Datasource<wbr>Name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:66</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The mongo data source name: see Mongo Client documentation.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getpasswordfield" class="tsd-anchor"></a>
					<h3>get<wbr>Password<wbr>Field</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Password<wbr>Field<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:82</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The property name to be used to set the name of the field, where the password is stored inside</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getpermissionfield" class="tsd-anchor"></a>
					<h3>get<wbr>Permission<wbr>Field</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Permission<wbr>Field<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:98</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The property name to be used to set the name of the field, where the permissions are stored inside.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getrolefield" class="tsd-anchor"></a>
					<h3>get<wbr>Role<wbr>Field</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Role<wbr>Field<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:114</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The property name to be used to set the name of the field, where the roles are stored inside.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getsaltfield" class="tsd-anchor"></a>
					<h3>get<wbr>Salt<wbr>Field</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Salt<wbr>Field<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:130</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The property name to be used to set the name of the field, where the SALT is stored inside.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getsaltstyle" class="tsd-anchor"></a>
					<h3>get<wbr>Salt<wbr>Style</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Salt<wbr>Style<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/hashsaltstyle.html" class="tsd-signature-type">HashSaltStyle</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:146</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The property name to be used to set the name of the field, where the salt style is stored inside</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <a href="../enums/hashsaltstyle.html" class="tsd-signature-type">HashSaltStyle</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getshared" class="tsd-anchor"></a>
					<h3>get<wbr>Shared</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Shared<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:162</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Use a shared Mongo client or not.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getusernamecredentialfield" class="tsd-anchor"></a>
					<h3>get<wbr>Username<wbr>Credential<wbr>Field</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Username<wbr>Credential<wbr>Field<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:178</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The property name to be used to set the name of the field, where the username for the credentials is stored inside.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getusernamefield" class="tsd-anchor"></a>
					<h3>get<wbr>Username<wbr>Field</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Username<wbr>Field<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:194</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The property name to be used to set the name of the field, where the username is stored inside.</p>
								</div>
							</div>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setcollectionname" class="tsd-anchor"></a>
					<h3>set<wbr>Collection<wbr>Name</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Collection<wbr>Name<span class="tsd-signature-symbol">(</span>collectionName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:42</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The property name to be used to set the name of the collection inside the config.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>collectionName: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the collection name</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setconfig" class="tsd-anchor"></a>
					<h3>set<wbr>Config</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Config<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:58</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The mongo client configuration: see Mongo Client documentation.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>config: <span class="tsd-signature-type">object</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the mongo config</p>
									</div>
									<ul class="tsd-parameters">
										<li class="tsd-parameter-index-signature">
											<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5>
										</li>
									</ul>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setdatasourcename" class="tsd-anchor"></a>
					<h3>set<wbr>Datasource<wbr>Name</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Datasource<wbr>Name<span class="tsd-signature-symbol">(</span>datasourceName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:74</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The mongo data source name: see Mongo Client documentation.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>datasourceName: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the data source name</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setpasswordfield" class="tsd-anchor"></a>
					<h3>set<wbr>Password<wbr>Field</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Password<wbr>Field<span class="tsd-signature-symbol">(</span>passwordField<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:90</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The property name to be used to set the name of the field, where the password is stored inside</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>passwordField: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the password field</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setpermissionfield" class="tsd-anchor"></a>
					<h3>set<wbr>Permission<wbr>Field</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Permission<wbr>Field<span class="tsd-signature-symbol">(</span>permissionField<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:106</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The property name to be used to set the name of the field, where the permissions are stored inside.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>permissionField: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the permission field</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setrolefield" class="tsd-anchor"></a>
					<h3>set<wbr>Role<wbr>Field</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Role<wbr>Field<span class="tsd-signature-symbol">(</span>roleField<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:122</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The property name to be used to set the name of the field, where the roles are stored inside.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>roleField: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the role field</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setsaltfield" class="tsd-anchor"></a>
					<h3>set<wbr>Salt<wbr>Field</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Salt<wbr>Field<span class="tsd-signature-symbol">(</span>saltField<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:138</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The property name to be used to set the name of the field, where the SALT is stored inside.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>saltField: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the salt field</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setsaltstyle" class="tsd-anchor"></a>
					<h3>set<wbr>Salt<wbr>Style</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Salt<wbr>Style<span class="tsd-signature-symbol">(</span>saltStyle<span class="tsd-signature-symbol">: </span><a href="../enums/hashsaltstyle.html" class="tsd-signature-type">HashSaltStyle</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:154</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The property name to be used to set the name of the field, where the salt style is stored inside</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>saltStyle: <a href="../enums/hashsaltstyle.html" class="tsd-signature-type">HashSaltStyle</a></h5>
									<div class="tsd-comment tsd-typography">
										<p>the salt style</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setshared" class="tsd-anchor"></a>
					<h3>set<wbr>Shared</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Shared<span class="tsd-signature-symbol">(</span>shared<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:170</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Use a shared Mongo client or not.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>shared: <span class="tsd-signature-type">boolean</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>true to use a shared client</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setusernamecredentialfield" class="tsd-anchor"></a>
					<h3>set<wbr>Username<wbr>Credential<wbr>Field</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Username<wbr>Credential<wbr>Field<span class="tsd-signature-symbol">(</span>usernameCredentialField<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:186</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The property name to be used to set the name of the field, where the username for the credentials is stored inside.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>usernameCredentialField: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the username credential field</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="setusernamefield" class="tsd-anchor"></a>
					<h3>set<wbr>Username<wbr>Field</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">set<wbr>Username<wbr>Field<span class="tsd-signature-symbol">(</span>usernameField<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:202</li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>The property name to be used to set the name of the field, where the username is stored inside.</p>
								</div>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>usernameField: <span class="tsd-signature-type">string</span></h5>
									<div class="tsd-comment tsd-typography">
										<p>the username field</p>
									</div>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="mongoauthoptions.html" class="tsd-signature-type">MongoAuthOptions</a></h4>
							<p>a reference to this, so the API can be used fluently</p>
						</li>
					</ul>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="../globals.html"><em>Globals</em></a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-enum">
						<a href="../enums/hashalgorithm.html" class="tsd-kind-icon">Hash<wbr>Algorithm</a>
					</li>
					<li class=" tsd-kind-enum">
						<a href="../enums/hashsaltstyle.html" class="tsd-kind-icon">Hash<wbr>Salt<wbr>Style</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="hashstrategy.html" class="tsd-kind-icon">Hash<wbr>Strategy</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="mongoauth.html" class="tsd-kind-icon">Mongo<wbr>Auth</a>
					</li>
				</ul>
				<ul class="current">
					<li class="current tsd-kind-class">
						<a href="mongoauthoptions.html" class="tsd-kind-icon">Mongo<wbr>Auth<wbr>Options</a>
						<ul>
							<li class=" tsd-kind-constructor tsd-parent-kind-class">
								<a href="mongoauthoptions.html#constructor" class="tsd-kind-icon">constructor</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#getcollectionname" class="tsd-kind-icon">get<wbr>Collection<wbr>Name</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#getconfig" class="tsd-kind-icon">get<wbr>Config</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#getdatasourcename" class="tsd-kind-icon">get<wbr>Datasource<wbr>Name</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#getpasswordfield" class="tsd-kind-icon">get<wbr>Password<wbr>Field</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#getpermissionfield" class="tsd-kind-icon">get<wbr>Permission<wbr>Field</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#getrolefield" class="tsd-kind-icon">get<wbr>Role<wbr>Field</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#getsaltfield" class="tsd-kind-icon">get<wbr>Salt<wbr>Field</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#getsaltstyle" class="tsd-kind-icon">get<wbr>Salt<wbr>Style</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#getshared" class="tsd-kind-icon">get<wbr>Shared</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#getusernamecredentialfield" class="tsd-kind-icon">get<wbr>Username<wbr>Credential<wbr>Field</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#getusernamefield" class="tsd-kind-icon">get<wbr>Username<wbr>Field</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#setcollectionname" class="tsd-kind-icon">set<wbr>Collection<wbr>Name</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#setconfig" class="tsd-kind-icon">set<wbr>Config</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#setdatasourcename" class="tsd-kind-icon">set<wbr>Datasource<wbr>Name</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#setpasswordfield" class="tsd-kind-icon">set<wbr>Password<wbr>Field</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#setpermissionfield" class="tsd-kind-icon">set<wbr>Permission<wbr>Field</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#setrolefield" class="tsd-kind-icon">set<wbr>Role<wbr>Field</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#setsaltfield" class="tsd-kind-icon">set<wbr>Salt<wbr>Field</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#setsaltstyle" class="tsd-kind-icon">set<wbr>Salt<wbr>Style</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#setshared" class="tsd-kind-icon">set<wbr>Shared</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#setusernamecredentialfield" class="tsd-kind-icon">set<wbr>Username<wbr>Credential<wbr>Field</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mongoauthoptions.html#setusernamefield" class="tsd-kind-icon">set<wbr>Username<wbr>Field</a>
							</li>
						</ul>
					</li>
				</ul>
				<ul class="after-current">
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>